QmiNAS.h

/*===========================================================================
FILE: 
   QmiNASAPI.h

DESCRIPTION:
   Gobi Network Access Service APIs

Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
                   Sierra Wireless Proprietary/GTDR
==========================================================================*/

#ifndef __GOBI_NAS_API_H__
#define __GOBI_NAS_API_H__
/*=========================================================================*/
// Definitions
/*=========================================================================*/


/*=========================================================================*/
// Structs
/*=========================================================================*/
#ifdef __cplusplus
        extern "C" {
#endif

#ifdef __cplusplus
        };
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/

//TLV 0x01 of QMI_NAS_SERVING_SYSTEM_IND 0x0024
IMPORTGOBI ULONG GOBICMAPI SetServingSystemCallback( 
        tFNServingSystem        pCallback );

//QMI_NAS_SERVING_SYSTEM_IND 0x0024
//Serving system info callback function (struct containing serving system, current plmn data capability and romaing indicator)
IMPORTGOBI ULONG GOBICMAPI SwiSetServingSystemInfoCallback( 
        tFNSwiServingSystemInfo pCallback );

//TLV 0x12 of QMI_NAS_SERVING_SYSTEM_IND 0x0024
IMPORTGOBI ULONG GOBICMAPI SetCurrentPlmnCallback( 
        tFNCurrentPlmn  pCallback );

//QMI_NAS_SET_3GPP2_SUBSCRIPTION_INFO 0x003F
IMPORTGOBI ULONG GOBICMAPI Set3Gpp2SubscriptionInfo( 
        BYTE*                           pNamId,
        MinBasedImsi*           pMinBasedImsi,
        TrueImsi*                       pTrueImsi,
        BYTE*                           pMdnLen,
        BYTE*                           pMdn
);

//QMI_NAS_GET_3GPP2_SUBSCRIPTION_INFO 0x003E
IMPORTGOBI ULONG GOBICMAPI Get3Gpp2SubscriptionInfo( 
        BYTE*                           pNamId,
        MinBasedImsi*           pMinBasedImsi,
        TrueImsi*                       pTrueImsi,
        BYTE*                           pMdnLen,
        BYTE*                           pMdn
);

//QMI_NAS_SET_DDTM_PREFERENCE 0x0037
IMPORTGOBI ULONG GOBICMAPI SetDdtmPreference( 
        BYTE            ddtmPref,
        WORD            ddtmAction,
        BYTE            soListAction,           //string array with fixed size of 16
        BYTE            numSoInstances, //also as input buffer size
        WORD*           pArrServiceOption
);

//QMI_NAS_GET_SYS_INFO 0x004D
IMPORTGOBI ULONG GOBICMAPI GetSysInfo(
        CdmaSystemInfo*         pCdmaSystemInfo,
        HdrSystemInfo*          pHdrSystemInfo,
        GsmSystemInfo*          pGsmSystemInfo,
        WcdmaSystemInfo*        pWcdmaSystemInfo,
        LteSystemInfo*          pLteSystemInfo,
        TdscdmaSystemInfo*      pTdscdmaSystemInfo); 

//QMI_NAS_GET_ERR_RATE 0x0052   
IMPORTGOBI ULONG GOBICMAPI GetErrRate( 
        WORD*                   pCdmaFrameErrorRate,
        WORD*                   pHdrPacketErrorRate,
        BYTE*                   pGsmBitErrorRate,
        BYTE*                   pWcdmaBlockErrorRate,
        BYTE*                   pTdscdmaBlockErrorRate
);      


//QMI_NAS_GET_HDR_COLOR_CODE 0x0057
IMPORTGOBI ULONG GOBICMAPI GetHdrColorCode( 
        BYTE*                   pColorCode
);

//QMI_NAS_GET_TX_RX_INFO 0x005A
IMPORTGOBI ULONG GOBICMAPI GetTxRxInfo( 
        BYTE            radioIf,
        RxInfo*         pRxInfoCh0,
        RxInfo*         pRxInfoCh1,
        TxInfo*         pTxInfo
);

//QMI_NAS_SWI_GET_HRPD_STATS 0x5561
IMPORTGOBI ULONG GOBICMAPI SwiGetHrpdStats( 
        BYTE*                   pDrcValue,
        BYTE*                   pDrcCover,
        BYTE*                   pArrUati,               //string array with fixed size of 16
        BYTE*                   pNumOfPilot,    //also as input buffer size
        HrpdPilot*              pHrpdPilot
);


//QMI_NAS_SWI_GET_CDMA_DOMINANT_PN 0x7560
IMPORTGOBI ULONG GOBICMAPI SwiGetCdmaDominantPn( 
        WORD*           p1xDominantPn,
        WORD*           pDoDominantPn
);

IMPORTGOBI ULONG GOBICMAPI SetPLMNModeCallback( tFNPLMNMode pCallback );

IMPORTGOBI ULONG GOBICMAPI SetSignalStrengthCallback( 
   tFNSignalStrength          pCallback,
   BYTE                       thresholdsSize,
   INT8 *                     pThresholds );

IMPORTGOBI ULONG GOBICMAPI SetLURejectCallback( tFNLUReject pCallback );

IMPORTGOBI ULONG GOBICMAPI SetRFInfoCallback( tFNRFInfo pCallback );

IMPORTGOBI ULONG GOBICMAPI SetRoamingIndicatorCallback( 
   tFNRoamingIndicator        pCallback );
   
IMPORTGOBI ULONG GOBICMAPI SetDataCapabilitiesCallback( 
   tFNDataCapabilities        pCallback );

   
IMPORTGOBI ULONG GOBICMAPI GetHomeNetwork( 
   WORD *                     pMCC, 
   WORD *                     pMNC, 
   BYTE                       nameSize, 
   CHAR *                     pName, 
   WORD *                     pSID, 
   WORD *                     pNID );

IMPORTGOBI ULONG GOBICMAPI SetNetworkPreference( 
   ULONG                      technologyPref, 
   ULONG                      duration );

IMPORTGOBI ULONG GOBICMAPI GetNetworkPreference( 
   ULONG *                    pTechnologyPref, 
   ULONG *                    pDuration, 
   ULONG *                    pPersistentTechnologyPref );

IMPORTGOBI ULONG GOBICMAPI SetCDMANetworkParameters( 
   CHAR *                     pSPC,
   BYTE *                     pForceRev0,
   BYTE *                     pCustomSCP,
   ULONG *                    pProtocol,
   ULONG *                    pBroadcast,
   ULONG *                    pApplication,
   ULONG *                    pRoaming );

IMPORTGOBI ULONG GOBICMAPI GetCDMANetworkParameters( 
   BYTE *                     pSCI,
   BYTE *                     pSCM,
   BYTE *                     pRegHomeSID,
   BYTE *                     pRegForeignSID,
   BYTE *                     pRegForeignNID,
   BYTE *                     pForceRev0,
   BYTE *                     pCustomSCP,
   ULONG *                    pProtocol,
   ULONG *                    pBroadcast,
   ULONG *                    pApplication,
   ULONG *                    pRoaming );

IMPORTGOBI ULONG GOBICMAPI GetACCOLC( BYTE * pACCOLC );

IMPORTGOBI ULONG GOBICMAPI SetACCOLC( 
   CHAR *                     pSPC,
   BYTE                       accolc );

IMPORTGOBI ULONG GOBICMAPI GetPLMNMode( ULONG * pMode );

IMPORTGOBI ULONG GOBICMAPI GetPLMNName(
   USHORT                     mcc,
   USHORT                     mnc,
   ULONG *                    pNamesSize, 
   BYTE *                     pNames );

IMPORTGOBI ULONG GOBICMAPI GetRFInfo( 
   BYTE *                     pInstanceSize, 
   BYTE *                     pInstances );

IMPORTGOBI ULONG GOBICMAPI PerformNetworkScan( 
   BYTE *                     pInstanceSize, 
   BYTE *                     pInstances );

IMPORTGOBI ULONG GOBICMAPI PerformNetworkRATScan( 
   BYTE *                     pInstanceSize, 
   BYTE *                     pInstances,
   BYTE *                     pRATSize, 
   BYTE *                     pRATInstances );

IMPORTGOBI ULONG GOBICMAPI InitiateNetworkRegistration( 
   ULONG                      regType,
   WORD                       mcc, 
   WORD                       mnc, 
   ULONG                      rat );

IMPORTGOBI ULONG GOBICMAPI InitiateDomainAttach( ULONG action );

IMPORTGOBI ULONG GOBICMAPI GetServingNetwork( 
   ULONG *                    pRegistrationState, 
   ULONG *                    pCSDomain, 
   ULONG *                    pPSDomain, 
   ULONG *                    pRAN, 
   BYTE *                     pRadioIfacesSize, 
   BYTE *                     pRadioIfaces, 
   ULONG *                    pRoaming, 
   WORD *                     pMCC, 
   WORD *                     pMNC, 
   BYTE                       nameSize, 
   CHAR *                     pName );

IMPORTGOBI ULONG GOBICMAPI GetServingNetworkCapabilities( 
   BYTE *                     pDataCapsSize, 
   BYTE *                     pDataCaps );

IMPORTGOBI ULONG GOBICMAPI GetANAAAAuthenticationStatus( ULONG * pStatus );

IMPORTGOBI ULONG GOBICMAPI GetSignalStrengths( 
   ULONG *                    pArraySizes, 
   INT8 *                     pSignalStrengths, 
   ULONG *                    pRadioInterfaces );
    // End of NAS group
#endif